public class OpenSessionInViewFilter extends OncePerRequestFilter
This filter makes Hibernate Sessions available via the current thread, which
will be autodetected by transaction managers. It is suitable for service layer
transactions via HibernateTransactionManager
as well as for non-transactional execution (if configured appropriately).
NOTE: This filter will by default not flush the Hibernate Session,
with the flush mode set to FlushMode.NEVER. It assumes to be used
in combination with service layer transactions that care for the flushing: The
active transaction manager will temporarily change the flush mode to
FlushMode.AUTO during a read-write transaction, with the flush
mode reset to FlushMode.NEVER at the end of each transaction.
WARNING: Applying this filter to existing logic can cause issues that have not appeared before, through the use of a single Hibernate Session for the processing of an entire request. In particular, the reassociation of persistent objects with a Hibernate Session has to occur at the very beginning of request processing, to avoid clashes with already loaded instances of the same objects.
Looks up the SessionFactory in Spring's root web application context.
Supports a "sessionFactoryBeanName" filter init-param in web.xml;
the default bean name is "sessionFactory". Looks up the SessionFactory on each
request, to avoid initialization order issues (when using ContextLoaderServlet,
the root application context will get initialized after this filter).
lookupSessionFactory(HttpServletRequest),
OpenSessionInViewInterceptor,
OpenSessionInterceptor,
HibernateTransactionManager,
TransactionSynchronizationManager,
org.hibernate.SessionFactory#getCurrentSession()| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DEFAULT_SESSION_FACTORY_BEAN_NAME |
private java.lang.String |
sessionFactoryBeanName |
ALREADY_FILTERED_SUFFIXlogger| Constructor and Description |
|---|
OpenSessionInViewFilter() |
| Modifier and Type | Method and Description |
|---|---|
private boolean |
applySessionBindingInterceptor(WebAsyncManager asyncManager,
java.lang.String key) |
protected void |
doFilterInternal(HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain)
Same contract as for
doFilter, but guaranteed to be
just invoked once per request within a single request thread. |
protected java.lang.String |
getSessionFactoryBeanName()
Return the bean name of the SessionFactory to fetch from Spring's
root application context.
|
protected SessionFactory |
lookupSessionFactory()
Look up the SessionFactory that this filter should use.
|
protected SessionFactory |
lookupSessionFactory(HttpServletRequest request)
Look up the SessionFactory that this filter should use,
taking the current HTTP request as argument.
|
protected Session |
openSession(SessionFactory sessionFactory)
Open a Session for the SessionFactory that this filter uses.
|
void |
setSessionFactoryBeanName(java.lang.String sessionFactoryBeanName)
Set the bean name of the SessionFactory to fetch from Spring's
root application context.
|
protected boolean |
shouldNotFilterAsyncDispatch()
Returns "false" so that the filter may re-bind the opened Hibernate
Session to each asynchronously dispatched thread and postpone
closing it until the very last asynchronous dispatch. |
protected boolean |
shouldNotFilterErrorDispatch()
Returns "false" so that the filter may provide a Hibernate
Session to each error dispatches. |
doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilteraddRequiredProperty, afterPropertiesSet, destroy, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContextpublic static final java.lang.String DEFAULT_SESSION_FACTORY_BEAN_NAME
private java.lang.String sessionFactoryBeanName
public void setSessionFactoryBeanName(java.lang.String sessionFactoryBeanName)
DEFAULT_SESSION_FACTORY_BEAN_NAMEprotected java.lang.String getSessionFactoryBeanName()
protected boolean shouldNotFilterAsyncDispatch()
Session to each asynchronously dispatched thread and postpone
closing it until the very last asynchronous dispatch.shouldNotFilterAsyncDispatch in class OncePerRequestFilterprotected boolean shouldNotFilterErrorDispatch()
Session to each error dispatches.shouldNotFilterErrorDispatch in class OncePerRequestFilterprotected void doFilterInternal(HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain)
throws ServletException,
java.io.IOException
OncePerRequestFilterdoFilter, but guaranteed to be
just invoked once per request within a single request thread.
See OncePerRequestFilter.shouldNotFilterAsyncDispatch() for details.
Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.
doFilterInternal in class OncePerRequestFilterServletExceptionjava.io.IOExceptionprotected SessionFactory lookupSessionFactory(HttpServletRequest request)
The default implementation delegates to the lookupSessionFactory()
variant without arguments.
request - the current requestprotected SessionFactory lookupSessionFactory()
The default implementation looks for a bean with the specified name in Spring's root application context.
getSessionFactoryBeanName()protected Session openSession(SessionFactory sessionFactory)
throws DataAccessResourceFailureException
The default implementation delegates to the SessionFactory#openSession
method and sets the Session's flush mode to "MANUAL".
sessionFactory - the SessionFactory that this filter usesDataAccessResourceFailureException - if the Session could not be createdorg.hibernate.FlushMode#MANUALprivate boolean applySessionBindingInterceptor(WebAsyncManager asyncManager, java.lang.String key)